home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmTransferValue.z / XmTransferValue
Encoding:
Text File  |  2002-10-03  |  10.2 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee - A toolkit function that transfers data to
  10.           a destination
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.  
  15.           vvvvooooiiiidddd XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee(
  16.           XXXXttttPPPPooooiiiinnnntttteeeerrrr ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd,
  17.           AAAAttttoooommmm ttttaaaarrrrggggeeeetttt,
  18.           XXXXttttCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc pppprrrroooocccc,
  19.           XXXXttttPPPPooooiiiinnnntttteeeerrrr cccclllliiiieeeennnntttt____ddddaaaattttaaaa,
  20.           TTTTiiiimmmmeeee ttttiiiimmmmeeee);
  21.  
  22.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  23.           This page documents Motif 2.1.
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee converts a selection, transferring any data
  27.           from the selection owner, in the context of an already-
  28.           initiated data transfer operation.  An application can call
  29.           this routine from an XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedure or any
  30.           function called as a result.
  31.  
  32.           The caller of XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee supplies the target to which
  33.           the selection is converted.  The caller also supplies a
  34.           callback procedure to handle the data that results from the
  35.           conversion.
  36.  
  37.           ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd
  38.                     Specifies a unique indentifier for the data
  39.                     transfer operation.  The value must be the same as
  40.                     the value of the ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd member of the
  41.                     XXXXmmmmDDDDeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt passed to the
  42.                     XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedure.
  43.  
  44.           _t_a_r_g_e_t    Specifies the target to which the selection is to
  45.                     be converted.
  46.  
  47.           _p_r_o_c      Specifies a callback procedure to be invoked when
  48.                     the selection has been converted and the data, if
  49.                     any, is available.  This procedure is responsible
  50.                     for inserting or otherwise handling any data
  51.                     transferred.  The procedure can also terminate the
  52.                     data transfer by calling XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee.  The _p_r_o_c
  53.                     receives three arguments:
  54.  
  55.                        +o  The widget that requested the conversion
  56.  
  57.                        +o  The value of the _c_l_i_e_n_t__d_a_t_a argument
  58.  
  59.                        +o  A pointer to an XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     This procedure can be called before or after
  75.                     XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeeereturns.
  76.  
  77.           _c_l_i_e_n_t__d_a_t_a
  78.                     Specifies data to be passed to the callback
  79.                     procedure (the value of the _p_r_o_c argument) when
  80.                     the selection has been converted.
  81.  
  82.           _t_i_m_e      Specifies the time of the _X_E_v_e_n_t that triggered
  83.                     the data transfer.  You should typically set this
  84.                     field to XXXXttttLLLLaaaassssttttTTTTiiiimmmmeeeessssttttaaaammmmppppPPPPrrrroooocccceeeesssssssseeeedddd.
  85.  
  86.           The callback procedure (the value of the _p_r_o_c argument)
  87.           receives a pointer to an XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt, which
  88.           has the following definition:
  89.  
  90.           typedef struct
  91.           {
  92.                   int _r_e_a_s_o_n;
  93.                   XEvent *_e_v_e_n_t;
  94.                   Atom _s_e_l_e_c_t_i_o_n;
  95.                   Atom _t_a_r_g_e_t;
  96.                   Atom _t_y_p_e;
  97.                   XtPointer _t_r_a_n_s_f_e_r__i_d;
  98.                   int _f_l_a_g_s;
  99.                   int _r_e_m_a_i_n_i_n_g;
  100.                   XtPointer _v_a_l_u_e;
  101.                   unsigned long _l_e_n_g_t_h;
  102.                   int _f_o_r_m_a_t;
  103.           } XmSelectionCallbackStruct;
  104.  
  105.           _r_e_a_s_o_n    Indicates why the callback was invoked.
  106.  
  107.           _e_v_e_n_t     Points to the _X_E_v_e_n_t that triggered the callback.
  108.                     It can be NULL.
  109.  
  110.           _s_e_l_e_c_t_i_o_n Specifies the selection that has been converted.
  111.  
  112.           _t_a_r_g_e_t    Specifies the target to which XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee
  113.                     requested conversion.  The value is the same as
  114.                     the value of the _t_a_r_g_e_t argument to
  115.                     XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee.
  116.  
  117.           _t_y_p_e      Specifies the type of the selection value.  This
  118.                     is not the target, but the type used to represent
  119.                     the target.  The value _X_T__C_O_N_V_E_R_T__F_A_I_L means that
  120.                     the selection owner did not respond to the
  121.                     conversion request within the Intrinsics selection
  122.                     timeout interval.
  123.  
  124.           ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd
  125.                     Specifies a unique indentifier for the data
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     transfer operation.  The value is the same as the
  141.                     value of the ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd argument to
  142.                     XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee.
  143.  
  144.           _f_l_a_g_s     This member is currently unused.  The value is
  145.                     always XXXXmmmmSSSSEEEELLLLEEEECCCCTTTTIIIIOOOONNNN____DDDDEEEEFFFFAAAAUUUULLLLTTTT.
  146.  
  147.           _r_e_m_a_i_n_i_n_g Indicates the number of transfers remaining for
  148.                     the operation specified by ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd.
  149.  
  150.           _v_a_l_u_e     Represents the data transferred by this request.
  151.                     The application is responsible for freeing the
  152.                     value by calling XXXXttttFFFFrrrreeeeeeee.
  153.  
  154.           _l_e_n_g_t_h    Indicates the number of elements of data in _v_a_l_u_e,
  155.                     where each element has the size symbolized by
  156.                     _f_o_r_m_a_t.  If _v_a_l_u_e is NULL, _l_e_n_g_t_h is 0.
  157.  
  158.           _f_o_r_m_a_t    Indicates whether the data in _v_a_l_u_e should be
  159.                     viewed as a list of _c_h_a_r, _s_h_o_r_t, or _l_o_n_g
  160.                     quantities.  Possible values are 8 (for a list of
  161.                     _c_h_a_r), 16 (for a list of _s_h_o_r_t), or 32 (for a list
  162.                     of _l_o_n_g).
  163.  
  164.      RRRREEEELLLLAAAATTTTEEEEDDDD
  165.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmeeeetttteeeerrrrssss(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrSSSSeeeennnnddddRRRReeeeqqqquuuueeeesssstttt(3), and
  166.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrttttRRRReeeeqqqquuuueeeesssstttt(3).
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.